docs: add a Data Connect guide and link it from the README - #3724
Conversation
Add docs/data-connect.md describing the Data Connect secondary entry point, following the same shape as the other product guides: a short intro, the dependency-injection setup (provideDataConnect/getDataConnect with a connector config, then inject(DataConnect)), and the wrap-the-SDK note. Add the Data Connect entry to the README feature table in its alphabetical slot after Cloud Storage, and re-flow the table into even two-column rows, which also fixes the previously lopsided final row. This supersedes angular#3673, which added the README entry but linked it to a docs/data-connect.md that did not exist (a dead link) and placed the row out of alphabetical order. Credit to @maneesht for adding the entry and flagging the gap. Firebase now brands this product "Firebase SQL Connect"; the guide keeps "Data Connect" as the primary name to match the @angular/fire/data-connect entry point and notes the new branding.
tyler-reitz
left a comment
tyler-reitz
left a comment
There was a problem hiding this comment.
Accurate and well-matched to the existing guides. I checked the DI sample against src/schematics/utils.ts:244, which generates exactly provideDataConnect(() => getDataConnect(<config>)), so the doc and ng add agree. The resulting README table is well-formed at 6 rows x 2 cells.
Two things before merge:
It preserves a dead link it's well positioned to fix
The table still carries:
#### [Vertex AI](docs/vertexai.md#vertex-ai)
import { } from '@angular/fire/vertexai';
But src/vertexai/ no longer exists on main — only src/ai/ — so that entry advertises a removed entry point. #3725's base branch replaces that cell with AI Logic and deletes docs/vertexai.md. Given this PR's stated purpose is fixing a dead table entry, doing both in one pass is cheaper than two rebases.
This will conflict with #3725
Both PRs edit the same region of the README feature table: this one re-flows the row boundaries around the last two cells, #3725 rewrites the content of the Vertex AI cell. Whichever lands second needs a manual rebase. Both are also stacked on unmerged predecessor work, so there's a merge order to respect regardless.
Nit
The alphabetical claim holds through Remote Config, but App Check and Vertex AI remain out of order at the end. Pre-existing — mentioning only because the description leads with alphabetization.
tyler-reitz
left a comment
tyler-reitz
left a comment
There was a problem hiding this comment.
Approving — the guide is accurate and matches the house style. The two points in my earlier comment (the stale Vertex AI table entry, and the README conflict with #3725) are worth resolving as part of the merge order, but neither blocks this.
armando-navarro
added
comp: data-connect
2 participants
Adds a Data Connect guide and wires it into the README feature table.
Data Connect support already shipped in the library (the
ng addschematics generate its config, #3638 and #3714), but there was no guide for it, and #3636 asked for exactly that. #3673 added a README table entry for Data Connect, but the entry linked to adocs/data-connect.mdthat did not exist (a dead link) and sat out of alphabetical order. This carries that contribution forward: it adds the missing guide and places the entry correctly. Credit to @maneesht for adding the entry and surfacing the gap.What's here
docs/data-connect.md: a new guide following the same shape as the other product guides (intro, dependency-injection setup withprovideDataConnect/getDataConnectand a connector config, theninject(DataConnect), and the standard "AngularFire wraps the Firebase JS SDK" note).README.md: the Data Connect entry, placed alphabetically after Cloud Storage, with the feature table re-flowed into even two-column rows (this also fixes the previously lopsided final row).Notes
@angular/fire/data-connectentry point and theDataConnectclass, and notes the new branding inline.@firebase/data-connecttype definitions:getDataConnect(options: ConnectorConfig)is a real overload, andConnectorConfigis{ location, connector, service }.Fixes #3636